Customer account rc doc - support doc generate #2768

brianshen1990 · 2025-04-14T19:55:19Z

Background

Customer account rc version now supports doc generate.

Solution

Follow admin's behvaiour

🎩

Demo video: https://screenshot.click/15-01-yjwfa-6clit.mp4

Sorry Spin is not working anymore...

Checklist

I have 🎩'd these changes
I have updated relevant documentation

brianshen1990 · 2025-04-15T15:53:35Z

packages/ui-extensions/docs/surfaces/customer-account/build-docs.mjs

@@ -0,0 +1,244 @@
+/* eslint-disable no-undef, no-console */


follow admin https://github.com/Shopify/ui-extensions/blob/bb8093b912c2e68bd6b8c68abde92d1dec4a46f2/packages/ui-extensions/docs/surfaces/admin/build-docs.mjs

Can you make the script re-usable and pass in the right paths instead of duplicating? It would be better for maintainance.

Please don't copy paste this script. Bring it up layers and make it reusable for everyone.

extracted all the shared functions, and let each service construct their own build steps

This is great progress but I think there is more to do. The directory customer-account could be an argument passed into the CLI that would remove a lot of duplicate code. I think there is a lot of duplication that still should be consolidated. extensions api version should be shared...

I think we should really aim at making one script with arguments that works for all surfaces instead of splitting it into reusable functions. I understand the time pressure folks are under so I am willing to be flexible but I think this still needs a second pass.

brianshen1990 · 2025-04-15T15:54:05Z

...ges/ui-extensions/docs/surfaces/customer-account/reference/apis/authenticated-account.doc.ts

-        "Provides information about the company of the authenticated business customer. The value is `undefined` if a business customer isn't authenticated.",
-      type: 'UseAuthenticatedAccountPurchasingCompanyGeneratedType',
-    },
+    // {


removing all the hooks for now, and will re-add them later once we have the hooks

brianshen1990 · 2025-04-15T15:55:14Z

packages/ui-extensions/package.json

@@ -5,7 +5,7 @@
    "docs:admin": "node ./docs/surfaces/admin/build-docs.mjs",
    "docs:checkout": "bash ./docs/surfaces/checkout/build-docs.sh",
    "docs:point-of-sale": "bash ./docs/surfaces/point-of-sale/build-docs.sh",
-    "docs:customer-account": "bash ./docs/surfaces/customer-account/build-docs.sh"
+    "docs:customer-account": "node ./docs/surfaces/customer-account/build-docs.mjs"


follow line 5 admin's behvaiour

brianshen1990 · 2025-04-15T15:56:43Z

packages/ui-extensions/src/surfaces/customer-account/components.d.ts

@@ -0,0 +1,128 @@
+export interface CustomerAccountActionProps {


copy and combined from all the components' d.ts file for now

brianshen1990 · 2025-04-15T15:57:26Z

packages/ui-extensions/src/surfaces/customer-account/components/Avatar/Avatar.doc.ts

no avatar for the 1st rc version

brianshen1990 · 2025-04-15T15:58:00Z

.../src/surfaces/customer-account/components/CustomerAccountAction/CustomerAccountAction.doc.ts

@@ -35,11 +35,6 @@ const data: ReferenceEntityTemplateSchema = {
    codeblock: {
      title: 'Basic CustomerAccountAction',
      tabs: [
-        {


remove all react examples for components as there is no ui-extensions-react

brianshen1990 · 2025-04-15T15:58:20Z

packages/ui-extensions/src/surfaces/customer-account/extension-targets.ts

@@ -106,10 +106,6 @@ export interface CustomerAccountExtensionTargets {
      FullPageApi,
    StandardComponents
  >;
-  'CustomerAccount::KitchenSink': RenderExtension<


remove the test KitchenSink target

vividviolet · 2025-04-15T20:44:09Z

packages/ui-extensions/docs/surfaces/customer-account/build-docs.mjs

@@ -0,0 +1,244 @@
+/* eslint-disable no-undef, no-console */


Can you make the script re-usable and pass in the right paths instead of duplicating? It would be better for maintainance.

vividviolet · 2025-04-15T20:45:14Z

packages/ui-extensions/docs/surfaces/customer-account/build-docs.mjs

+    .replace(/&#039;/g, "'");
+};
+
+const htmlWrapper = (htmlString, layout) => {


I think this won't work for customer accounts. Maybe we should have a way to exclude previews. Thought @Fionoble @alex-page ?

This can be renamed to adminHTMLWrapper and the templates below could be updated to include admin as well and use the adminHTMLWrapper. It's quite a simple adjustment but will ensure they can add their own templates.

extracted some shared functions and make transformJson customizable 0459c0c

alex-page · 2025-04-15T23:37:41Z

packages/ui-extensions/docs/surfaces/customer-account/build-docs.mjs

+  await fs.cp(generatedDocsPath, shopifyDevDBPath, {recursive: true});
+};
+
+const generateExtensionsDocs = async () => {


This function should be brought into the admin docs generator and be named something with customer accounts name.

extracted some shared functions and make transformJson customizable 0459c0c

alex-page

This is a great prototype but we should consolidate here instead of duplicate 90% of the work. Happy to support the consolidation but it's likely just adding prefixes to ensure docs do not overlap and have clear functions for each area.

brianshen1990 · 2025-04-16T03:35:56Z

packages/ui-extensions/docs/surfaces/admin/build-docs.mjs

+    rootPath,
+    generatedDocsDataFile,
+    generatedStaticPagesFile,
+    transformJson: (filePath) => transformJson(filePath, true),


now this is an optional function, admin will pass it

brianshen1990 · 2025-04-16T03:37:09Z

packages/ui-extensions/docs/surfaces/admin/build-docs.mjs

+    outputDir,
+    rootPath,
+    generatedDocsDataFile,
+    transformJson: (filePath) => transformJson(filePath, false),


we do not pass generatedStaticPagesFile here so that generateFiles will know do not replace non-existing static json file

brianshen1990 · 2025-04-16T03:38:08Z

packages/ui-extensions/docs/surfaces/build-doc-shared.mjs

@@ -0,0 +1,72 @@
+/* eslint-disable no-undef, no-console */
+import childProcess from 'child_process';
+import fs from 'fs/promises';


all extracted from admin's buold-docs scripts. All these functions will only use parameters, no global variables any more

brianshen1990 · 2025-04-16T03:38:20Z

packages/ui-extensions/docs/surfaces/build-doc-shared.mjs

+    replaceValue: '',
+  });
+
+  if (transformJson) {


transformJson become optional

brianshen1990 · 2025-04-16T03:47:38Z

Hey @alex-page and @vividviolet , I

moved all non doc generation scripts into another PR so that this will be much easier to review;
and extracted some shared functions and make transformJson customizable

can you help to give another review? thanks

example test video here https://screenshot.click/15-56-qwuux-c1885.mp4

Good progress. I think more should be done but folks are racing for deadlines.

oluwatimio

Approving as it looks good on my end. I guess there's still some concerns about sharing as much logic as possible. We can look to improve the script even more, although not sure how deep we want to go into that for this PR

brianshen1990 changed the base branch from unstable to 2025-07-rc April 14, 2025 19:55

brianshen1990 force-pushed the customer-account-rc---support-doc-generate branch from 79048ab to 1b2c949 Compare April 15, 2025 15:52

brianshen1990 commented Apr 15, 2025

View reviewed changes

brianshen1990 force-pushed the customer-account-rc---support-doc-generate branch 3 times, most recently from aa5819d to 883ed8d Compare April 15, 2025 16:49

brianshen1990 requested review from oluwatimio, sylvhama, jamesvidler and vividviolet April 15, 2025 16:50

brianshen1990 self-assigned this Apr 15, 2025

brianshen1990 marked this pull request as ready for review April 15, 2025 16:51

vividviolet reviewed Apr 15, 2025

View reviewed changes

alex-page reviewed Apr 15, 2025

View reviewed changes

alex-page previously requested changes Apr 15, 2025

View reviewed changes

brianshen1990 commented Apr 16, 2025

View reviewed changes

brianshen1990 requested review from vividviolet and alex-page April 16, 2025 03:47

brianshen1990 changed the title ~~Customer account rc support doc generate~~ Customer account rc doc - support doc generate Apr 16, 2025

Customer account rc doc - support doc generate

a61ae38

brianshen1990 force-pushed the customer-account-rc---support-doc-generate branch from 1fc0607 to a61ae38 Compare April 16, 2025 04:37

brianshen1990 changed the base branch from 2025-07-rc to customer-account-rc-doc---remove-react-examples April 16, 2025 04:38

oluwatimio approved these changes Apr 16, 2025

View reviewed changes

sylvhama removed their request for review April 16, 2025 20:52

brianshen1990 merged commit 69c63db into customer-account-rc-doc---remove-react-examples Apr 17, 2025
4 checks passed

brianshen1990 mentioned this pull request Apr 17, 2025

Customer account rc doc - support doc generate #2785

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Customer account rc doc - support doc generate #2768

Customer account rc doc - support doc generate #2768

brianshen1990 commented Apr 14, 2025 •

edited

Loading

brianshen1990 Apr 15, 2025

vividviolet Apr 15, 2025

alex-page Apr 15, 2025

brianshen1990 Apr 16, 2025

alex-page Apr 16, 2025 •

edited

Loading

brianshen1990 Apr 15, 2025 •

edited

Loading

brianshen1990 Apr 15, 2025

brianshen1990 Apr 15, 2025

brianshen1990 Apr 15, 2025

brianshen1990 Apr 15, 2025

brianshen1990 Apr 15, 2025

vividviolet Apr 15, 2025

vividviolet Apr 15, 2025

alex-page Apr 15, 2025

brianshen1990 Apr 16, 2025

alex-page Apr 15, 2025

brianshen1990 Apr 16, 2025

alex-page left a comment •

edited

Loading

brianshen1990 Apr 16, 2025

brianshen1990 Apr 16, 2025

brianshen1990 Apr 16, 2025

brianshen1990 Apr 16, 2025

brianshen1990 commented Apr 16, 2025 •

edited

Loading

oluwatimio left a comment

		@@ -0,0 +1,128 @@
		export interface CustomerAccountActionProps {

Customer account rc doc - support doc generate #2768

Customer account rc doc - support doc generate #2768

Conversation

brianshen1990 commented Apr 14, 2025 • edited Loading

Background

Solution

🎩

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alex-page Apr 16, 2025 • edited Loading

Choose a reason for hiding this comment

brianshen1990 Apr 15, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alex-page left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brianshen1990 commented Apr 16, 2025 • edited Loading

oluwatimio left a comment

Choose a reason for hiding this comment

brianshen1990 commented Apr 14, 2025 •

edited

Loading

alex-page Apr 16, 2025 •

edited

Loading

brianshen1990 Apr 15, 2025 •

edited

Loading

alex-page left a comment •

edited

Loading

brianshen1990 commented Apr 16, 2025 •

edited

Loading